Inside Macintosh: QuickDraw GX Objects /

Chapter 6 - Transform Objects / Transform Objects Reference

Functions / Getting and Setting the Clip

GXGetShapeClip

You can use the GXGetShapeClip function to retrieve the clip property of a transform object associated with a specified shape.

gxShape GXGetShapeClip(gxShape source);

source

A reference to the shape whose transform object you want to examine the clip property of.

function result

A reference to a newly created shape encapsulating information copied from the clip property of the source shape's transform object.

DESCRIPTION

The GXGetShapeClip function creates a new shape object, copies into it geometry information from the clip property of the source shape's transform object, and returns a reference to the new shape as the function result.

Note that the returned shape object is a copy; you can alter it without affecting the clip property of the source shape's transform. If you call this function and alter the clip shape it returns, you can then assign that changed clip shape back to the shape's transform object by calling the GXSetShapeClip function.

SPECIAL CONSIDERATIONS

If no error occurs, the GXGetShapeClip function creates a shape object; you are responsible for disposing of that object when you no longer need it.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil

SEE ALSO

For information about the clip property of transform objects, see "Clip" on page 6-7.

To alter the clip property of a transform object associated with a particular shape, use the GXSetShapeClip function, described in the next section.

If you want to manipulate the clip property of a particular transform object, you can
use the GXGetTransformClip function, described on page 6-43, or the GXSetTransformClip function, described on page 6-44.